home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / FILER / SPLIT212.SPK / !Split / !Help < prev    next >
Text File  |  1995-12-29  |  19KB  |  453 lines
  1.  
  2.                               ====================
  3.                               !Split  Version 2.12
  4.                               ====================
  5.  
  6.  ****************************** Copyright Notice ******************************
  7.  *                                                                            *
  8.  *   This application is copyright Adam Hamilton.                             *
  9.  *   Permission to use, copy, and distribute !Split, for non-commercial       *
  10.  *   purposes, is hereby granted, provided:-                                  *
  11.  *                                                                            *
  12.  *     • No charge is made other than to cover the cost of the medium.        *
  13.  *                                                                            *
  14.  *     • All files and documents are included in the distribution unaltered.  *
  15.  *                                                                            *
  16.  *   You may upload this software to a Bulletin Board, or include it in       *
  17.  *   your Public Domain library. If you do this, please try and let me        *
  18.  *   know, so I can keep you up to date with any future changes.              *
  19.  *   The authors permission must be obtained before this application is       *
  20.  *   included on any magazine disk, or with any other software.               *
  21.  *                                                                            *
  22.  *   You may not sell this software, or use it otherwise for personal gain.   *
  23.  *                                                                            *
  24.  *   If you change any part of this software, you must obtain permission      *
  25.  *   from the author, before distribution.                                    *
  26.  *                                                                            *
  27.  *   This program is supplied 'as is' with no guarantee of its suitability    *
  28.  *   for any purpose. I will not be held responsible for any damage arising   *
  29.  *   from the use or misuse of this software.                                 *
  30.  *                                                                            *
  31.  *   I reserve the right to change these terms and conditions at any time.    *
  32.  *                                                                            *
  33.  ******************************************************************************
  34.  
  35.  
  36. Contacting The Author
  37. ~~~~~~~~~~~~~~~~~~~~~
  38.  
  39.    Bug reports, comments and any donations may be sent to me, the author,
  40.    at this address :-
  41.  
  42.              Adam Hamilton,
  43.              23 Northmeadow Road,
  44.              Cricklade,
  45.              Swindon,
  46.              Wiltshire,  SN6 6LT,
  47.              England.
  48.  
  49.    I may also be contacted by E-Mail:    aph@swindon.gpsemi.com
  50.  
  51.  
  52. ================================================================================
  53.  
  54. 1  Introduction
  55.  
  56.    !Split was written to ease the transportation of large files from one
  57.    computer to another. No attempt to compress the file is made, as it is
  58.    assumed this has already been done. !Split will split a file into a number
  59.    of smaller files, and will join them again when required.
  60.  
  61.  
  62.  
  63. 2  How To Use !Split
  64.  
  65.    !Split can be started either by running the application directly or via
  66.    a double click on a split file (see section 2.3, 'Joining Files').
  67.  
  68.  
  69.  2.1  The iconbar menu
  70.  
  71.       Pressing the menu button on the iconbar icon will display a menu.
  72.  
  73.       Info              This displays information about the program.
  74.  
  75.       Autoload          When joining files, if this option is selected, !Split
  76.                         will automatically attempt to locate the next part to
  77.                         join.
  78.  
  79.       Faster            If selected, the multi-tasking window will not be
  80.                         updated with bytes read and written, making the
  81.                         operation faster. A tick will be displayed when this
  82.                         option is selected.
  83.  
  84.       Single Task       This option will toggle between single and
  85.                         multi-tasking. A tick will be displayed when this option
  86.                         is selected.
  87.  
  88.       Quit              This will quit the program.
  89.  
  90.  
  91.       The default action of Autoload, Faster, and Single Task options may be
  92.       changed (see section 3, 'Customizing').
  93.  
  94.  
  95.  2.2  Splitting Files
  96.  
  97.       The split window can be displayed either by clicking on the iconbar icon
  98.       with select, or by dragging a file to the iconbar icon. Figure 1 shows an
  99.       example of the split window. Please note, you may open and close filer
  100.       windows, or change floppy disks between saving.
  101.  
  102.  
  103.                  ---------------------------------------------
  104.                 |             -----------------------------   |
  105.                 |    Source  |s::IDEDisc5.$.Music.RaveAlert|  |
  106.                 |             -----------------------------   |
  107.                 |             ----------      -               |
  108.                 |  Filesize  |      1423| K  | |              |
  109.                 |             ----------      -               |
  110.                 |             ----------      -               |
  111.                 |  Filename  | RaveAler |    |€| Single save  |
  112.                 |             ----------      -               |
  113.                 |        -------            -------           |
  114.                 |       | Close |          | Split |          |
  115.                 |        -------            -------           |
  116.                  ---------------------------------------------
  117.  
  118.                            Figure 1: Split window
  119.  
  120.  
  121.   2.2.1  Source
  122.  
  123.          Enter the filename for the file you want to split, or simply drag
  124.          the file to the split window. If you drag, the Filename field will
  125.          automatically get filled in, although you can still change it if you
  126.          wish.
  127.  
  128.  
  129.   2.2.2  Filename
  130.  
  131.          This is the 'base' filename to be used for each part the file is split
  132.          into. Using the example above, the base name is RaveAler so the parts
  133.          will be named RaveAler01, RaveAler02, ... etc.
  134.  
  135.  
  136.   2.2.3  Filesize
  137.  
  138.          This is the maximum file size in K (1024 bytes), that you want each
  139.          part to be saved as. You may either type the size into the text icon,
  140.          or press the select or menu mouse buttons on the menu icon opposite.
  141.          You may then choose from one of the sizes in the menu. The default
  142.          size and the contents of the menu can be customized (see section 3,
  143.          'Customizing').
  144.  
  145.  
  146.   2.2.4  Single save
  147.  
  148.          If this option is set, !Split will automatically save all parts to the
  149.          same directory, only one drag is needed. This option may be switched
  150.          on or off during saving. The default setting for this option may be
  151.          customized (see section 3, 'Customizing').
  152.  
  153.  
  154.   2.2.5  Close
  155.  
  156.          Pressing this button will close the split window. If splitting has
  157.          started, closing the split window will not affect this process.
  158.  
  159.  
  160.   2.2.6  Split
  161.  
  162.          Pressing Split will open the `save as' window, shown in figure 2 below,
  163.          (if all the parameters have been set correctly), prompting you to drag
  164.          the icon to a directory window. If the Single Task option has not been
  165.          selected from the iconbar menu, then a transfer window will be
  166.          displayed and the splitting process will begin (see section 2.4,
  167.          'The Transfer Window'). If you only want to save certain parts, then
  168.          use the Skip button to miss out the current part.
  169.  
  170.  
  171.                           -------------------------
  172.                          |          -----          |
  173.                          |         |     |         |
  174.                          |         |     |         |
  175.                          |          -----          |
  176.                          |      -------------      |
  177.                          |     | RaveAler01  |     |
  178.                          |      -------------      |
  179.                          |  --------    --------   |
  180.                          | | Cancel |  |  Skip  |  |
  181.                          |  --------    --------   |
  182.                           -------------------------
  183.  
  184.                            Figure 2: Saveas window
  185.  
  186.  
  187.  2.3  Joining Files
  188.  
  189.       The join window can be opened either by clicking on the iconbar icon with
  190.       adjust, double clicking or dragging to the iconbar icon, a file of type
  191.       'Split'. If you opened the window with the adjust mouse button, you must
  192.       double click or drag the first file to the join window. If you maximize
  193.       the join window you will see some short hints to help you along. Figure 3
  194.       shows an example of the join window.
  195.  
  196.  
  197.            -----------------------------------------------------------
  198.           |   Save as               |   Info                          |
  199.           |          -----          |                                 |
  200.           |         |     |         |  Part 1 of 2.                   |
  201.           |         |     |         |  Drag file to directory window. |
  202.           |          -----          |                                 |
  203.           |      -------------      |                                 |
  204.           |     |  RaveAlert  |     |                                 |
  205.           |      -------------      |                                 |
  206.           |  --------    --------   |  Using buffer size of 192K      |
  207.           | | Cancel |  |  Save  |  |                                 |
  208.           |  --------    --------   |                                 |
  209.            -----------------------------------------------------------
  210.  
  211.                             Figure 3: Join window
  212.  
  213.  
  214.       Once !Split has the first part of the file to join, you need to tell it
  215.       where to save the joined file. To do this, simply drag the file icon to
  216.       the directory where you want it saved, or type the path into the text icon
  217.       and press Save. Pressing Save without a full path in the text icon, will
  218.       save the file in the current directory.
  219.  
  220.       If the Autoload option is on, !Split will automatically look for the next
  221.       part to join. If it is found, joining will continue, otherwise joining
  222.       will be suspended and you will need to either double click on the next
  223.       part (filetyped as 'Split'), or drag it to the join window or the iconbar
  224.       icon.
  225.  
  226.       If single tasking is not enabled, the transfer window will be displayed
  227.       (see section 2.4, 'The Transfer Window').
  228.  
  229.       If Cancel is pressed, joining is aborted and the window closes.
  230.  
  231.  
  232.  2.4  The Transfer Window
  233.  
  234.       The transfer window is displayed when splitting or joining has started
  235.       and multi-tasking is enabled. Figure 4 shows an example of the transfer
  236.       window.
  237.  
  238.  
  239.                  -------------------------------------------
  240.                 |   -------------------------------------   |
  241.                 |  |               Reading               |  |
  242.                 |  |sc5.$.!C.Source.Split.test.RaveAler01|  |
  243.                 |   -------------------------------------   |
  244.                 |               589824 bytes read           |
  245.                 |               458752 bytes written        |
  246.                 |  -------   --------   --------   -------  |
  247.                 | | Abort | | Faster | | S-Task | | Pause | |
  248.                 |  -------   --------   --------   -------  |
  249.                  -------------------------------------------
  250.  
  251.                           Figure 4: Transfer window
  252.  
  253.  
  254.       The transfer window shows what the program is doing and on what file, it
  255.       also shows the number of bytes read and written. The function of the
  256.       buttons are outlined below:-
  257.  
  258.       Abort             This will abort the operation, and close the window.
  259.  
  260.       Faster/Slower     This will disable/enable the display of information in
  261.                         the window, resulting in slightly faster operation. This
  262.                         lasts for the duration of the current file operation.
  263.  
  264.       S-Task            This will put the program into single task mode for the
  265.                         duration of this file operation only.
  266.  
  267.       Pause/Continue    This will pause/resume the transfer operation.
  268.  
  269.  
  270.       Please note, once in single task mode, control is removed from the
  271.       transfer window.
  272.  
  273.  
  274.  
  275. 3  Customizing
  276.  
  277.    !Split may be customized is several ways.
  278.  
  279.  
  280.  3.1  Changing the buffer size
  281.  
  282.       The buffer size used to temporarily store data can be changed (this will
  283.       slightly affect the speed of the program). To do this, open the
  284.       application directory by holding down the Shift key and double clicking on
  285.       the !Split icon. Once inside, load the !Run file into your favourite text
  286.       editor.
  287.  
  288.       To change the maximum buffer size, increase or decrease the value of the
  289.       -max option on the WimpSlot command. For example:-
  290.  
  291.       WimpSlot -min 96k -max 640k
  292.  
  293.       Please do not change the -min size.
  294.  
  295.  
  296.  3.2  Iconbar menu
  297.  
  298.       The default status of the Autoload, Faster, and Single Task options in the
  299.       iconbar menu may be set. To do this, load the !Run file into a text editor
  300.       (as above), then add or remove the following commands in the line
  301.       beginning with: Run <Split$Dir>.!RunImage
  302.  
  303.       -autoload         This will default the Autoload option to on.
  304.  
  305.       -faster           This will default the Faster option to on.
  306.  
  307.       -singletask       This will default the Single Task option to on.
  308.  
  309.  
  310.       For example, if I want !Split to start up with only the Faster option
  311.       selected, I would have the following line:-
  312.  
  313.       Run <Split$Dir>.!RunImage -faster %*0
  314.  
  315.  
  316.       Please note, as the Faster and Single Task options cannot be on at the
  317.       same time, -singletask would take precedence.
  318.  
  319.  
  320.  3.3  Single save
  321.  
  322.       The default status of the Single save button in the split window may be
  323.       set. Edit the !Run file as above and add or remove -singlesave. For
  324.       example, to have single save on, your Run command may now look like this:-
  325.  
  326.       Run <Split$Dir>.!RunImage -faster -singlesave %*0
  327.  
  328.  
  329.  3.4  Filesize
  330.  
  331.       To set the default filesize, edit the !Run file as above and add the
  332.       following option to the Run command:-
  333.  
  334.       -filesize n       Where n is the filesize in K (1024 bytes).
  335.  
  336.  
  337.       For example, your Run command may now look like this:-
  338.  
  339.       Run <Split$Dir>.!RunImage -faster -singlesave -filesize 713 %*0
  340.  
  341.  
  342.       The size is now suitable for saving to double density DOS formatted floppy
  343.       disks.
  344.  
  345.  
  346.  3.5  Filesize menu
  347.  
  348.       The filesize menu may also be customized. To do this, open the Resources
  349.       directory, and load the SizeMenu file into a text editor. The file is made
  350.       up of two columns, the first is file size in Kbytes, the second (which is
  351.       optional) is the text which will appear in the filesize menu. If only the
  352.       file size number is used, then that number will appear in the menu.
  353.  
  354.       The next time you start !Split, it should read in your new menu.
  355.  
  356.  
  357.  
  358. 4  History
  359.  
  360.    Versions 1.xx are command line versions, which are supported along side the
  361.    desktop versions (2.00 and greater).
  362.  
  363.    • Version 1.00-1.08  These were the original command line versions compiled
  364.                         on several different computers.
  365.  
  366.    • Version 1.10       This version has a new file format, a header is put at
  367.                         the beginning of each part, and is used to join files in
  368.                         the correct order. This version is compatible with the
  369.                         desktop version (2.00 and greater).
  370.  
  371.    • Version 1.11       Slightly increased memory allocation for filenames, and
  372.                         added a small check needed for DEC Ultrix compilers.
  373.  
  374.    • Version 1.12       Added -interactive option to allow direct reading and
  375.                         writing of floppy disks. This option enables different
  376.                         paths to be given for each part, removing the need, for
  377.                         example, to load all the parts onto the hard disk before
  378.                         joining.
  379.  
  380.    • Version 1.12c      Supports official Acorn filetype.
  381.  
  382.    • Version 1.13       Modified the Acorn specific bits to speed up file
  383.                         access. Also tidied and commented the code a lot more.
  384.                         NOTE: The only executables changed from version 1.12
  385.                         are the Acorn ones, therefore I have only compiled
  386.                         this version for these machines.
  387.  
  388.  
  389.  
  390.    • Version 2.00       First desktop version.
  391.  
  392.    • Version 2.01       Added ability to open join window with the Adjust
  393.                         button, and to drag files to the window. This made it
  394.                         easier to start the joining procedure if the files
  395.                         aren't filetyped as 'Split'. Fixed bug with ArcFS image
  396.                         file system doesn't complain about archives any more.
  397.  
  398.    • Version 2.02       Added filesize menu, fixed a few small bugs.
  399.  
  400.    • Version 2.10       Big jump from 2.02 to 2.10 because I decided to
  401.                         completely re-write the program from scratch without the
  402.                         use of RISC_OSLib functions. This has made the program
  403.                         easier to write, control, modify, and has made the code
  404.                         smaller and it also runs faster.
  405.  
  406.    • Version 2.11       Added multi-tasking option. Fixed a few small bugs.
  407.  
  408.    • Version 2.11c      Fixed menu item height. As of this version, !Split uses
  409.                         an official Acorn filetype.
  410.  
  411.    • Version 2.12       Speeded up file operations. Increased the amount of data
  412.                         transferred each WIMP Poll. More meaningful text in the
  413.                         size menu. Added ability to skip parts when splitting.
  414.                         New option to autoload join parts.
  415.  
  416.    • Version 2.12d      Bug fixes.
  417.  
  418.    • Version 2.12e      Original filename stored in first part now stores '/'
  419.                         as '.', making it joinable on a DOS/unix etc machine.
  420.  
  421.  
  422.  
  423. 5  Files supplied
  424.  
  425.    The following files are supplied inside the !Split application directory.
  426.  
  427.    !Boot
  428.    !Help                  This file.
  429.    HelpPS                 PostScript version of this file.
  430.    !Run
  431.    !RunImage              Main program.
  432.    !Sprites, !Sprites22
  433.    Resources (directory)  Contains ...
  434.      SizeMenu             Definition of the filesize menu (see section 3,
  435.                           'Customizing').
  436.      Toggle3D             Toggles the state of the 3D bit in CMOS RAM.
  437.      ToggleDRAG           Toggles the state of solid dragging bit in CMOS RAM.
  438.      Template2D           2D window templates.
  439.      Template3D           3D window templates, RiscOS 3 or greater.
  440.  
  441.    The program will automatically select the correct templates file to use.
  442.  
  443.  
  444.  
  445. 6  Acknowledgments
  446.  
  447.    I would like to thank Andrew Sellors for his suggestions and help in testing
  448.    this application.
  449.  
  450.    Thanks to Sergio Monesi for his suggestion on speeding up file operations.
  451.  
  452. ================================================================================
  453.